<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpdisplay: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties">
<link rel="prev" href="GimpChannel.html" title="gimpchannel">
<link rel="next" href="GimpDrawable.html" title="gimpdrawable">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GimpDisplay.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GimpDisplay.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GimpDisplay.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GimpChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GimpDrawable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GimpDisplay"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpDisplay.top_of_page"></a>gimpdisplay</span></h2>
<p>gimpdisplay — Functions to create, delete and flush displays (views) on an image.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GimpDisplay.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="returnvalue">GimpDisplay</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpDisplay.html#gimp-display-get-by-id" title="gimp_display_get_by_id ()">gimp_display_get_by_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint32</span>
</td>
<td class="function_name">
<a class="link" href="GimpDisplay.html#gimp-display-get-id" title="gimp_display_get_id ()">gimp_display_get_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="returnvalue">GimpDisplay</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpDisplay.html#gimp-display-new" title="gimp_display_new ()">gimp_display_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpDisplay.html#gimp-display-delete" title="gimp_display_delete ()">gimp_display_delete</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpDisplay.html#gimp-display-is-valid" title="gimp_display_is_valid ()">gimp_display_is_valid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpDisplay.html#gimp-display-id-is-valid" title="gimp_display_id_is_valid ()">gimp_display_id_is_valid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="GimpDisplay.html#gimp-display-get-window-handle" title="gimp_display_get_window_handle ()">gimp_display_get_window_handle</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpDisplay.html#gimp-displays-flush" title="gimp_displays_flush ()">gimp_displays_flush</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpDisplay.html#gimp-displays-reconnect" title="gimp_displays_reconnect ()">gimp_displays_reconnect</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpDisplay.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><span class="type">int</span></td>
<td class="property_name"><a class="link" href="GimpDisplay.html#GimpDisplay--id" title="The “id” property">id</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpDisplay.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GimpDisplay
</pre>
</div>
<div class="refsect1">
<a name="GimpDisplay.description"></a><h2>Description</h2>
<p>Functions to create, delete and flush displays (views) on an image.</p>
</div>
<div class="refsect1">
<a name="GimpDisplay.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-display-get-by-id"></a><h3>gimp_display_get_by_id ()</h3>
<pre class="programlisting"><a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="returnvalue">GimpDisplay</span></a> *
gimp_display_get_by_id (<em class="parameter"><code><span class="type">gint32</span> display_id</code></em>);</pre>
<p>Returns a <a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="type">GimpDisplay</span></a> representing <em class="parameter"><code>display_id</code></em>
.</p>
<div class="refsect3">
<a name="gimp-display-get-by-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>display_id</p></td>
<td class="parameter_description"><p>The display id.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-display-get-by-id.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="type">GimpDisplay</span></a> for <em class="parameter"><code>display_id</code></em>
or
<code class="literal">NULL</code> if <em class="parameter"><code>display_id</code></em>
does not represent a valid display.
The object belongs to libgimp and you must not modify or
unref it. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-display-get-id"></a><h3>gimp_display_get_id ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span>
gimp_display_get_id (<em class="parameter"><code><a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="type">GimpDisplay</span></a> *display</code></em>);</pre>
<div class="refsect3">
<a name="gimp-display-get-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>The display.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-display-get-id.returns"></a><h4>Returns</h4>
<p> the display ID.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-display-new"></a><h3>gimp_display_new ()</h3>
<pre class="programlisting"><a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="returnvalue">GimpDisplay</span></a> *
gimp_display_new (<em class="parameter"><code><a class="link" href="GimpImage.html" title="gimpimage"><span class="type">GimpImage</span></a> *image</code></em>);</pre>
<p>Create a new display for the specified image.</p>
<p>Creates a new display for the specified image. If the image already
has a display, another is added. Multiple displays are handled
transparently by GIMP. The newly created display is returned and can
be subsequently destroyed with a call to <a class="link" href="GimpDisplay.html#gimp-display-delete" title="gimp_display_delete ()"><code class="function">gimp_display_delete()</code></a>. This
procedure only makes sense for use with the GIMP UI, and will result
in an execution error if called when GIMP has no UI.</p>
<div class="refsect3">
<a name="gimp-display-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>image</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-display-new.returns"></a><h4>Returns</h4>
<p>The new display. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-display-delete"></a><h3>gimp_display_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_display_delete (<em class="parameter"><code><a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="type">GimpDisplay</span></a> *display</code></em>);</pre>
<p>Delete the specified display.</p>
<p>This procedure removes the specified display. If this is the last
remaining display for the underlying image, then the image is
deleted also. Note that the display is closed no matter if the image
is dirty or not. Better save the image before calling this
procedure.</p>
<div class="refsect3">
<a name="gimp-display-delete.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>The display to delete.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-display-delete.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-display-is-valid"></a><h3>gimp_display_is_valid ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_display_is_valid (<em class="parameter"><code><a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="type">GimpDisplay</span></a> *display</code></em>);</pre>
<p>Returns TRUE if the display is valid.</p>
<p>This procedure checks if the given display is valid and refers to
an existing display.</p>
<div class="refsect3">
<a name="gimp-display-is-valid.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>The display to check.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-display-is-valid.returns"></a><h4>Returns</h4>
<p> Whether the display is valid.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-display-id-is-valid"></a><h3>gimp_display_id_is_valid ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_display_id_is_valid (<em class="parameter"><code><span class="type">gint</span> display_id</code></em>);</pre>
<p>Returns TRUE if the display ID is valid.</p>
<p>This procedure checks if the given display ID is valid and refers to
an existing display.</p>
<div class="refsect3">
<a name="gimp-display-id-is-valid.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>display_id</p></td>
<td class="parameter_description"><p>The display ID to check.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-display-id-is-valid.returns"></a><h4>Returns</h4>
<p> Whether the display ID is valid.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-display-get-window-handle"></a><h3>gimp_display_get_window_handle ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_display_get_window_handle (<em class="parameter"><code><a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="type">GimpDisplay</span></a> *display</code></em>);</pre>
<p>Get a handle to the native window for an image display.</p>
<p>This procedure returns a handle to the native window for a given
image display. For example in the X backend of GDK, a native window
handle is an Xlib XID. A value of 0 is returned for an invalid
display or if this function is unimplemented for the windowing
system that is being used.</p>
<div class="refsect3">
<a name="gimp-display-get-window-handle.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>The display to get the window handle from.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-display-get-window-handle.returns"></a><h4>Returns</h4>
<p> The native window handle or 0.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-displays-flush"></a><h3>gimp_displays_flush ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_displays_flush (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Flush all internal changes to the user interface</p>
<p>This procedure takes no arguments and returns nothing except a
success status. Its purpose is to flush all pending updates of image
manipulations to the user interface. It should be called whenever
appropriate.</p>
<div class="refsect3">
<a name="gimp-displays-flush.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-displays-reconnect"></a><h3>gimp_displays_reconnect ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_displays_reconnect (<em class="parameter"><code><a class="link" href="GimpImage.html" title="gimpimage"><span class="type">GimpImage</span></a> *old_image</code></em>,
                         <em class="parameter"><code><a class="link" href="GimpImage.html" title="gimpimage"><span class="type">GimpImage</span></a> *new_image</code></em>);</pre>
<p>Reconnect displays from one image to another image.</p>
<p>This procedure connects all displays of the old_image to the
new_image. If the old_image has no display or new_image already has
a display the reconnect is not performed and the procedure returns
without success. You should rarely need to use this function.</p>
<div class="refsect3">
<a name="gimp-displays-reconnect.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>old_image</p></td>
<td class="parameter_description"><p>The old image (must have at least one display).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_image</p></td>
<td class="parameter_description"><p>The new image (must not have a display).</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-displays-reconnect.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GimpDisplay.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GimpDisplay--id"></a><h3>The <code class="literal">“id”</code> property</h3>
<pre class="programlisting">  “id”                       <span class="type">int</span></pre>
<p>The display id for internal use.</p>
<p>Owner: GimpDisplay</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>